/*
 * Copyright 2010 JAPIS
 *
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option) any
 * later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

package com.googlecode.xdoclet.ignore;


import java.util.Collection;

import org.generama.ConfigurableDocletTagFactory;
import org.generama.QDoxCapableMetadataProvider;


/**
 * Mock implementation of a QDox capable metadata provider.
 * 
 * @author japis.3des
 */
public class MockMetadataProvider implements QDoxCapableMetadataProvider {

    /**
     * See {@link #getDocletTagFactory()}.
     */
    private ConfigurableDocletTagFactory factory = new MockDocletTagFactory();

    /**
     * Constructs a mock instance.
     */
    public MockMetadataProvider() {
        super();
    }

    /**
     * Returns a {@link MockDocletTagFactory}.
     * 
     * @return a mock factory
     */
    public ConfigurableDocletTagFactory getDocletTagFactory() {
        return this.factory;
    }

    /**
     * Empty mock implementation.
     * 
     * @return <code>null</code>
     */
    public Collection getMetadata() {
        return null;
    }

    /**
     * Empty mock implementation.
     * 
     * @param metadata not used
     * @return <code>null</code>
     */
    public String getOriginalFileName(Object metadata) {
        return null;
    }

    /**
     * Empty mock implementation.
     * 
     * @param metadata not used
     * @return <code>null</code>
     */
    public String getOriginalPackageName(Object metadata) {
        return null;
    }

}
